Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update diagram support to correspond to Kroki v0.24.1 #56

Merged
merged 8 commits into from
Mar 21, 2024

Conversation

bauglir
Copy link
Owner

@bauglir bauglir commented Mar 21, 2024

This brings the package up-to-date with the state of supported diagrams up to Kroki v0.24.1.

  • Add direct support for D2, DBML, Symbolator, Tikz/PGF, and Wireviz diagrams.
  • Remove JPEG output support for PlantUML (including C4PlantUML) and Structurizr.
  • Add PDF output support for PlantUML (including C4PlantUML) and Structurizr.
  • Remove the obsolete BlockDiag service container.

Closes #42, #46.

bauglir added 8 commits March 21, 2024 12:02
Uses https://github.com/kevinpt/symbolator to render VHDL/Verilog
diagrams. Support was added in [email protected].

References #42.
Uses https://github.com/pgf-tikz/pgf to render Tikz/PGF plots. Support
was added in [email protected].

References #42, closes #46.
Uses https://github.com/formatc1702/WireViz to render wiring diagrams.
Support was added in [email protected].

References #42.
Previously the `blockdiag` related diagrams were grouped together
resulting in some other diagram types having been inserted into
incorrect locations, e.g. `diagramsnet`. To prevent these types of
issues it's better if lexical ordering is applied everywhere.
As of [email protected][^1] the BlockDiag related tools, i.e. ActDiag,
BlockDiag, NwDiag, PacketDiag, RackDiag, and SeqDiag are incorporated
into the "core" container image. Therefore the separate container is no
longer necessary.

[^1]: https://github.com/yuzutech/kroki/releases/tag/v0.22.0
@bauglir bauglir self-assigned this Mar 21, 2024
@bauglir bauglir enabled auto-merge March 21, 2024 14:37
Copy link

codecov bot commented Mar 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (bc66b51) to head (4f12a16).

Additional details and impacted files
@@              Coverage Diff              @@
##           development       #56   +/-   ##
=============================================
  Coverage       100.00%   100.00%           
=============================================
  Files                5         5           
  Lines              147       147           
=============================================
  Hits               147       147           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bauglir bauglir merged commit c00adc5 into development Mar 21, 2024
11 of 12 checks passed
@bauglir bauglir deleted the update-diagram-support branch March 21, 2024 14:45
bauglir added a commit that referenced this pull request Mar 21, 2024
This was committed (and merged) incorrectly in #56. The corresponding
workflow was previously not marked as required.
bauglir added a commit that referenced this pull request Mar 21, 2024
"TikZ/PGF" was incorrectly marked as "Symbolator" in #56 as a result of
copy and pasting/duplicating the line when adding TikZ/PGF support.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add support for diagram types added to the service since the last release
1 participant